NDepend.API Documentation
GetIssues(IRule,IQueryExecutionSuccessResult,IDictionary<RuleIdOrCategory,IReadOnlyList<ISuppressMessage>>) Method
NDepend.CodeQuery Namespace > ExtensionMethodsQuery Class > GetIssues Method : GetIssues(IRule,IQueryExecutionSuccessResult,IDictionary<RuleIdOrCategory,IReadOnlyList<ISuppressMessage>>) Method
The issues built rule, that can be obtained from NDepend.Issue.IIssue.NDepend.Issue.IIssue.Rule.
The query execution success result from which issues are inferred.
The usages of System.Diagnostics.CodeAnalysis.SuppressMessageAttribute collection used to infer NDepend.Issue.IRuleIssues.NDepend.Issue.IRuleIssues.SuppressedIssues
Gets issues of rule from queryExecutionSuccessResult.
Syntax
[Extension()]
public static IRuleIssues GetIssues( 
   IRule rule,
   IQueryExecutionSuccessResult queryExecutionSuccessResult,
   IDictionary<RuleIdOrCategory,IReadOnlyList<ISuppressMessage>> suppressedMessages
)

Parameters

rule
The issues built rule, that can be obtained from NDepend.Issue.IIssue.NDepend.Issue.IIssue.Rule.
queryExecutionSuccessResult
The query execution success result from which issues are inferred.
suppressedMessages
The usages of System.Diagnostics.CodeAnalysis.SuppressMessageAttribute collection used to infer NDepend.Issue.IRuleIssues.NDepend.Issue.IRuleIssues.SuppressedIssues
Remarks
This methods calls GetIssues(IRule,IQueryExecutionSuccessResult,IssueReferenceRecord) with the value NDepend.Issue.IssueReferenceRecord.NDepend.Issue.IssueReferenceRecord.No.
A rule prefix can be warnif count == 0 which means that the value of NDepend.Issue.IRuleIssues.NDepend.Issue.IRuleIssues.IsRuleViolated of the returned NDepend.Issue.IRuleIssues can be true even if NDepend.Issue.IRuleIssues.Issues is empty. However if IQueryExecutionSuccessResult.IsARuleViolated is false, NDepend.Issue.IRuleIssues.Issues is empty even if the rule has some match.

The NDepend.TechnicalDebt.DebtSettings object used to infer default values for debt and annual-interest (if these evalues are not provided by queryExecutionSuccessResult). and used to provide thresholds to compute NDepend.Issue.IIssue.NDepend.Issue.IIssue.Severity, is the NDepend.TechnicalDebt.DebtSettings object that was set in QueryExecutionContext.QueryExecutionContext.DebtSettings.
Calling this method might modify the queryExecutionSuccessResult object because of suppressed issues. If some issues are suppressed, the following properties might return a different result after calling this method: queryExecutionSuccessResult.IQueryExecutionSuccessResult.IsARuleViolated, queryExecutionSuccessResult.IQueryExecutionSuccessResult.MatchedCodeElements, queryExecutionSuccessResult.Records. In such case you can find the suppressed issues in the result NDepend.Issue.IRuleIssues.NDepend.Issue.IRuleIssues.SuppressedIssues.
Requirements

Target Platforms: Windows 11, 10, 8, 7 and Linux, MacOS with net8.0, net7.0 or net6.0 installed

See Also

Reference

ExtensionMethodsQuery Class
ExtensionMethodsQuery Members
Overload List

Send Feedback